Download Objects From Bucket
AutomatR.AWS.Activities.DownloadObjectsFromBucket
The "Download Objects From Bucket" activity in AutomatR is part of the AWS S3 (Simple Storage Service) activities package, enabling automation processes to download objects from a specified Amazon S3 bucket to a local system. This activity streamlines object retrieval tasks from an S3 bucket, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS S3 service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS S3 service. String variables containing the secret access key. |
| Region | Specifies the Amazon S3 region associated with the source bucket, needed for downloading the objects. Use the RegionEndpoint enumeration to set the region. |
| Bucket Name | Specifies the name of the Amazon S3 bucket from which objects will be downloaded. String variables containing the bucket name. |
| Folder Path | Specifies the full local folder path where objects from the specified bucket will be downloaded. String variables containing the local folder path. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Download Objects From Bucket" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Download Objects From Bucket" operation, indicating whether the objects were successfully downloaded or encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Download Objects From Bucket" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, Amazon S3 region, bucket name, and local folder path.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to download objects from the specified Amazon S3 bucket to the local system.
Example: Consider an example where the "Download Objects From Bucket" activity is used to download objects from an S3 bucket named "MyBucket" to the local folder path "C:\DownloadedFiles":
Download Objects From Bucket:
Display Name: "Download S3 Objects"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Bucket Name: "MyBucket"
Folder Path: "C:\DownloadedFiles"
Result: isDownloadSuccessful
In this example, the activity downloads objects from the "MyBucket" S3 bucket to the local folder path "C:\DownloadedFiles". The result of the operation (success or failure) is stored in the Boolean variable "isDownloadSuccessful" for further handling in the workflow.